[Doc] Update V1 user guide for embedding models #19842
Conversation
Signed-off-by: 22quinn <33176974+22quinn@users.noreply.github.com>
|
👋 Hi! Thank you for contributing to the vLLM project. 💬 Join our developer Slack at https://slack.vllm.ai to discuss your PR in #pr-reviews, coordinate on features in #feat- channels, or join special interest groups in #sig- channels. Just a reminder: PRs would not trigger full CI run by default. Instead, it would only run Once the PR is approved and ready to go, your PR reviewer(s) can run CI to test the changes comprehensively before merging. To run CI, PR reviewers can either: Add 🚀 |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @22quinn, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request primarily updates the V1 user guide documentation to accurately reflect the current status of embedding models. Following the successful integration of previous work (PR #16188), embedding models are now marked as fully functional, and outdated sections detailing their "Work In Progress" status and future plans have been removed to streamline the guide.
Highlights
- Documentation Update: The status of "Embedding Models" in the V1 user guide has been updated from "🚧 WIP" (Work In Progress) to "🟢 Functional", reflecting their current operational state after the merge of PR #16188.
- Content Refinement: An entire subsection detailing the "WIP" status and future plans for embedding models has been removed from the documentation, as this information is now obsolete given their functional status.
- Minor Formatting: Trailing whitespace characters were removed from several lines defining status indicators, improving document cleanliness.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
This pull request updates the V1 user guide for embedding models, reflecting their new status as 'Functional' after the merge of PR #16188. The changes involve:
- Updating the status of 'Embedding Models' in the main model support table from '🚧 WIP' to '🟢 Functional'.
- Removing the link to the merged PR #16188 from this table entry.
- Removing the detailed sub-section under 'Models not yet supported in V1' that previously described the WIP status and future plans for Embedding Models. This is logical as they are now considered functional.
- Minor stylistic cleanup by removing trailing spaces from some list items in the status legend.
The changes are consistent with the PR's purpose and improve the accuracy and clarity of the documentation. No issues of medium or higher severity were identified in this review.
github-actions
bot
added
the
ready
Signed-off-by: 22quinn <33176974+22quinn@users.noreply.github.com> Signed-off-by: juncheoll <th6re8e@naver.com>
Signed-off-by: 22quinn <33176974+22quinn@users.noreply.github.com>
Signed-off-by: 22quinn <33176974+22quinn@users.noreply.github.com> Signed-off-by: juncheoll <th6re8e@naver.com>
Signed-off-by: 22quinn <33176974+22quinn@users.noreply.github.com> Signed-off-by: minpeter <kali2005611@gmail.com>
Signed-off-by: 22quinn <33176974+22quinn@users.noreply.github.com>
Signed-off-by: 22quinn <33176974+22quinn@users.noreply.github.com>
Signed-off-by: 22quinn <33176974+22quinn@users.noreply.github.com> Signed-off-by: Will Eaton <weaton@redhat.com>
Signed-off-by: 22quinn <33176974+22quinn@users.noreply.github.com>
Signed-off-by: 22quinn <33176974+22quinn@users.noreply.github.com>
Essential Elements of an Effective PR Description Checklist
supported_models.mdandexamplesfor a new model.Purpose
Update V1 pooling support status following the merge of #16188
Test Plan
N/A
Test Result
N/A
(Optional) Documentation Update
Done